home *** CD-ROM | disk | FTP | other *** search
/ CD School House 10 / CD School House - Education and Games (10.0) - Wayzata Technology (1995).iso / mac / DOS / MISC / MEM200 / MEMORIZE.DOC < prev    next >
Text File  |  1994-12-08  |  18KB  |  363 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.         ▄██████▄ ▄██████ ▄██████▄ ▄█████▄ ██████▄ ▐██▌ ███████ ▄██████
  7.         ██ ██ ██ ██▄▄▄▄  ██ ██ ██ ██   ██ ██   ██  ██     ▄██▀ ██▄▄▄▄
  8.         ██ ██ ██ ██▀▀▀▀  ██ ██ ██ ██   ██ ██████   ██   ▄██▀   ██▀▀▀▀
  9.         ██ ██ ██ ▀██████ ██ ██ ██ ▀█████▀ ██  ▀██ ▐██▌ ███████ ▀██████
  10.  
  11.  
  12.  
  13.  
  14.  
  15.                                  Version 2.00
  16.  
  17.  
  18.  
  19.  
  20.                           (c) 1993 by David Gurecki
  21.  
  22.  
  23.  
  24.  
  25.                                   Disclaimer
  26.                               ==================
  27.  
  28.   The author of this program is in no way responsible for any damage, either
  29. software or hardware, which may result as a use of this program.  Use at
  30. your own risk.
  31.  
  32.  
  33.  
  34.                                Note to Readers
  35.                            =======================
  36.  
  37.   This version of Memorize still may have some bugs in it.  It has been beta-
  38. tested on a few machines, but unexpected results may yet occur.  I have
  39. attempted to get it working the best I could, but I cannot predict everything.
  40. If you encounter an error which occurs consistently, please send mail to
  41. the addresses listed below and describe to me the problem, so that I may
  42. make provisions to fix it in upcoming versions.
  43.  
  44.  
  45.  
  46.                                  Introduction
  47.                              ====================
  48.  
  49.   Memorize is a program to aid students in studying for quizes and tests.
  50. Being a student is not easy, especially in Junior High, High School, and
  51. College.  There's always have a test or a quiz coming up, and many students
  52. either drive themselves crazy trying to study, or just don't study at all.
  53. Now, there's an easier solution...
  54.   Memorize, very simply, is a program which asks you a question, and allows
  55. you to type in an answer.  Just give the program a list of questions and
  56. answers, and you can quiz yourself over and over again until you know the
  57. answer to each question.  The program keeps score of how many questions you
  58. answer correctly and incorrectly, so you can watch your score improve each
  59. time you go through a quiz.  It can also randomize the question order, swap
  60. the questions and answers (i.e., ask you the answer, and you have to type in
  61. the question), and keep track of the time it takes to complete a quiz.  For
  62. those who register, the program also will count a question correct if you only
  63. have part of the answer (partial credit).  This is useful if you are a bad
  64. speller, or don't know the entire answer, but know enough to be correct.
  65.   Memorize can be used for Foreign Language vocabulary, basic facts/trivia,
  66. and memorizing phone numbers, names, dates, places, words, or anything else.  
  67. It can be used for anything that requires memorization of two items.  Using 
  68. Memorize to study repeatedly may actually help you save time studying for 
  69. tests, and time is a very valuable thing for students.  If you can get a score 
  70. of 100 three or four times in a row with Memorize, you definately know the 
  71. words, and are fully prepared for whatever quiz or test you have to take.  You 
  72. cannot and should not study for *every* test with Memorize.  But the ones you 
  73. can and do use Memorize for, you will find come a lot easier.
  74.  
  75.  
  76.  
  77.                                 How To Use It
  78.                             =====================
  79.  
  80. 1. Program Syntax
  81. -----------------
  82.   When you type Memorize without command line parameters, this is what is
  83. displayed:
  84.  
  85.  
  86. ** Memorize 2.00 **
  87.  
  88. Usage: memorize [file1] [file2] ... [file8]
  89.        memorize [config.cfg] [file1] [file2] ... [file7]
  90.  
  91. Where:
  92.     [file1]...[file8] are files containing quiz data,
  93.     [config.cfg] is any config file ending in ".cfg".
  94.  
  95.  
  96.   On the command line, you may specify either one or more word files, a config
  97. file, or a config file AND one or more word files. (Both are described below.)
  98. All these files must be in the same directory as the Memorize program itself.
  99. It is recommended you make a separate directory, into which you place Memorize,
  100. and all the files you will use with it.  If you specify a config file, it must
  101. end in ".cfg", AND be the first file after the word Memorize.  Also, please see
  102. the section about Word File restrictions.
  103.  
  104.  
  105. 2. The Word Files
  106. -----------------
  107.   The first thing to do is create a word file.  This is a file containing all
  108. the questions and their corresponding answers.  Memorize reads this file to
  109. determine what questions to ask you, and what answers you should be typing in.
  110. The format is as follows: Question 1 on the first line, answer to question 1
  111. on the second line.  Question 2 on the third line, answer to question 2 on the
  112. fourth line...etc.
  113.  
  114. Here is an example...
  115. ===================
  116. Line 1:  What is the capital of New York?
  117. Line 2:  Albany
  118. Line 3:  Who is buried in Grants Tomb?
  119. Line 4:  Grant
  120. Line 5:  When was the war of 1812?
  121. Line 6:  1812
  122. ===================
  123.  
  124. Here is an example of a Spanish vocab file...
  125. ===================
  126. uno
  127. one
  128. adios
  129. goodbye
  130. hola
  131. hello
  132. ===================
  133.  
  134.   (NOTE: In the first example, Line 1, Line 2, etc. is shown to indicate the
  135. line numbers.  These would not be present in an actual file, as in the second
  136. example.)
  137.  
  138. Word File RESTRICTIONS:
  139. -----------------------
  140.   In creating your Word Files, please remember the following restrictions:
  141.  
  142. - ALL files specified must be in the same directory as the
  143.   Memorize.exe program; you cannot specify a path along with the
  144.   file name.
  145. - You can specify up to 10 files to be used as word files.  No more
  146.   than 10 files *total* can be specified in a config file (see
  147.   below) and on the command line.
  148. - All the files cannot have a combined length of more than 500 lines.
  149.   Similarly, no individual file can be more than 500 lines.
  150. - The length of each line should not be more than 70 characters long.
  151. - Do not leave any blank lines in the file.  This WILL cause an error.
  152. - The file should have an even number of lines.  An odd number will result
  153.   in the last line being truncated.
  154.  
  155. If any of these conditions should occur, an error message will be displayed,
  156. and the particular file may be excluded.  If there is a problem with every
  157. file you specified, the program will exit, since it has no quiz data to
  158. process.
  159.  
  160.  
  161. 2. The Configuration File
  162. -------------------------
  163.   Memorize has a few options that can be configured from within the program.
  164. If use the same settings over and over, you now have the ability to specify
  165. those in a config file.  You can also specify one or more Word Files in the
  166. config file.  Here is the format.  (Default values are shown).
  167.  
  168. ==============
  169. 0              < Randomize Questions Option 1 = ON, 0 = OFF
  170. 0              < Switch questions/answers   1 = ON, 0 = OFF
  171. 0              < Case Sensitivity           1 = ON, 0 = OFF
  172. 0              < Time quiz sessions         1 = ON, 0 = OFF
  173. 50             < Partial Credit percentage*
  174. [file1]        < Up to 10 Word Files (optional)
  175. [file2]          .
  176. [file3]          .
  177. .                .
  178. .                .
  179. [file10]       <-'
  180. ==============
  181.  
  182. "Randomize Questions" will cause the program to ask the questions in a random
  183. order if ON, and in the order as they occur in the file if OFF.
  184.  
  185. "Switch questions/answers" causes the program to ask what would normally be the
  186. answer, and use the question as what the user has to type in when ON.  (i.e.,
  187. Line 1 would become the answer, and Line 2 would become the question, etc.)
  188. This is useful if you know some words from Spanish to English, and want to
  189. study them from English to Spanish.  A setting of OFF treats the questions and
  190. answers as they normally are.
  191.  
  192. "Case Sensitivity" will treat a capital "A" and a small "a" in a response as
  193. different letters if set to ON, and will treat them as the same letter if set
  194. to OFF.
  195.  
  196. "Time Quiz Sessions" will report the elapsed time of a quiz session when it is
  197. done, along with displaying your score for that quiz, if set to ON.  If set to
  198. OFF, it will only display your score.
  199.  
  200. "Partial Credit percentage" is the percentage of the correct answer you must 
  201. get in order for the answer to be counted as a correct response. A value of 
  202. "50" means half the word, "75" would be 3/4 of the word, etc.  For example, if 
  203. the correct answer is "memorize" and you type "memo", you would get credit for 
  204. that question, since you got 4 out of 8 letters, or 50%, correct.  You would 
  205. also get the same credit if you typed "emor", "mori", "oriz", "rize", or more
  206. than 4  correct letters.  A value of "0" disables partial credit checking.
  207.  
  208. =================================================================
  209. How it works: The program checks pairs of letters to the correct answer.  If
  210. the answer was "memo", the program would first see if me was in the correct
  211. answer.  It then would check for "em", and then "mo".  The number of letters
  212. found in the answer as a result of this process is divided with the total
  213. number of letters in the correct answer to determine a percentage.  If that
  214. percentage is equal to or higher than the amount you specify, it will consider
  215. that question correct.
  216. ==================================================================
  217.  
  218. ** NOTE: This option is available only to REGISTERED users. See below for
  219. information on how to Register. **
  220.  
  221. Specifying Word Files in the Config File
  222. ----------------------------------------
  223.   Finally, you may optionally specify up to 10 files in the config file to be
  224. used as Word Files (see the section describing Word Files for the format).
  225. The program will read these files BEFORE any specified on the command line
  226. after the config file.  They are also held by the same restrictions as any
  227. Word File.  If you have, for example, 7 Word Files listed in a config file,
  228. you may have no more than 3 on the command line, because there can only be
  229. a total of 10 Word Files. You can leave these blank, and have the Partial
  230. Credit value the last line of your configuration file. However, you will
  231. HAVE to specify Word Files on the command line in this case, since Memorize
  232. has no other specified Word Files.
  233.  
  234.  
  235. 4. The Program
  236. --------------
  237.   Once you have created your Word File(s) or Config File, you are ready to run
  238. the program.  When it first loads, it checks each file to make sure it is
  239. within the guidelines.  The program also reads in any config file's options at
  240. this point.  If any errors do occur, they will be displayed, so that you will
  241. be informed as to why a file is not included.  The program then pauses whether
  242. there were any errors of not, to give you a chance to see them.
  243.   The program then asks you if you would like color.  NOTE: Memorize no longer
  244. uses ANSI codes to display color, so you do not need to load it in CONFIG.SYS
  245. as you have had to in the past.  Still, it gives you the option for color or
  246. not.
  247.   Then, the Title screen is displayed, as well as if the program is registered
  248. or not. When you register, your name will appear on the title screen.  From
  249. here, you can either choose to (C)onfigure, (B)egin, or (Q)uit...
  250.   Choosing 'B' will start the quiz with either the default settings, or the
  251. settings loaded from a config file, if you specified one.  Choosing 'Q' will
  252. cause the program to exit.
  253.   Choosing 'C' will allow you to change any of the program options (described
  254. in the "Config File" section), and displays to you the list of files, their
  255. lengths, and some other information.  You can toggle any of the options by
  256. pressing their highlighted (or parenthesised) letters, and change the Partial
  257. Credit percentage value.  You can also exit the program by pressing 'Q'.  Once
  258. you have configured the options to your liking, press ENTER to begin the quiz.
  259.  
  260. The Quiz
  261. --------
  262.   The questions are displayed one by one, and you have to type the appropriate
  263. response at the "?" prompt.  At the top of the screen, the current and total
  264. question numbers are displayed.  Note that, when you are answering the
  265. questions, you can exit the program by pressing CTRL-C, and ENTER.  A little
  266. heart character will appear, but the program will recognize that you pressed
  267. Control-C once you have pressed ENTER. If you have case sensitivity set to ON,
  268. you will have to type your response EXACTLY the same as the correct answer. If
  269. it is OFF, case will not matter, and you can type a capital where a lower-case
  270. letter should be, etc.  If you have partial credit set to "ON" (and are
  271. registered), the program will highlight the letters in both the question and
  272. the answer which match. If you disable partial credit, or have an unregistered
  273. copy, then the program will display the correct answer below what you typed if
  274. you are wrong, and a "Correct!" message if you are right.  You will then be
  275. prompted to press ENTER before going to the next question.  After you answer
  276. the final question, you will be shown a count of how many you got right, how
  277. many you got wrong, and what your percentage correct is.  If you specified the
  278. option of Timing the quiz session, the program will also display the elapsed
  279. time from when it displayed the first question, to when you pressed ENTER after
  280. the last question.  From here, you will be given the opportunity to go through
  281. the quiz again, or exit the program.
  282.  
  283.  
  284.                                 * SHAREWARE *
  285.                               =================
  286.  
  287.   Version 2.00 of Memorize is released as Shareware.  For the few who might
  288. be unfamiliar with it, and for those who've forgotten what it is, Shareware
  289. means that you can use the program for a trial period, and then if you
  290. continue using it, must Register your copy with the Author.  For Memorize,
  291. I would ask for a mere $5 when you Register, if you appreciate and use this
  292. program. It is just like buying some expensive game at a software store, except
  293. that you get it from a BBS, and it is not expensive.
  294.   Many authors put time delays, beeps and bells, and many nag messages to get
  295. you to register. You'll find none of these in Memorize, aside from a single
  296. message in the Configuration screen reminding you to register. As an incentive
  297. to register, you will be able to use the Partial Credit feature described
  298. above. Please remember, though, you are paying for the use of the whole 
  299. program, not just for the Partial Credit feature.
  300.   Once you do decide to register, you will be sent instructions on how to set 
  301. up the program to recognize that you have Registered.  Your name will then 
  302. appear every time you load the program, recognizing that it is YOUR copy.  By
  303. registering, you will be entitled to a Registered copy of Version 2.00 and the
  304. next official release.  You will be notified in the mail when the next version
  305. is released.  You are the owner of that copy and only that copy, and you may 
  306. not give it to anyone else.  You may, however, freely distribute the MEM200 
  307. archive, and you are encouraged to do so.  Print out "register.doc", and fill 
  308. out the form to register.  You will be sent the means by which to register in 
  309. the mail.
  310.   One last note... Previous versions have been released as Public Domain. You
  311. do not and will never have to pay for the either of those versions.  However,
  312. if you want access to some of the more advanced features, then you will want
  313. to get 2.00, which IS Shareware.
  314.  
  315.  
  316.                              Note from the Author
  317.                              ====================
  318.  
  319.   Memorize started out as a simple program for myself to help me study and
  320. review vocabulary for quizzes.  I then got the idea to distribute it and give
  321. everyone else the opportunity to study for tests using their computer. I
  322. gave it to a few boards, releasing it as Public Domain. I would never have
  323. imagined the response I would get.  People sent me mail about how they could
  324. study for school using Memorize, as well as other things, including memorizing
  325. telephone numbers, BBS names, etc.  I also got many suggestions on how to
  326. enhance the program, and improve its cabilities.  All of this positive
  327. response prompted me to continue its development.
  328.   And before long, I released version 1.5, and got still more feedback on how
  329. to improve te program.  So, here it is.. Version 2.00. I've tried to get
  330. out as many of the bugs as I could, but there's always the possibility of
  331. discovering new ones.  As before, I greatly appreciate any comments, feedback,
  332. and suggestions on how to improve! And, remember, it's now Shareware, so I hope
  333. you'll register if you get a lot of use out of it, and feel that the weeks of
  334. hard work to help you do better in school might just be worth a measley $5...
  335.  
  336.  
  337. ** Enjoy the program! **
  338.  
  339.      David Gurecki,
  340.      Author of Memorize
  341.  
  342. Mail Addresses:
  343. ---------------
  344. Internet Addresses: gurecki@erda.rl.af.mil
  345.                     david.gurecki@f2.n2609.z1.fidonet.org
  346.  
  347.       Fido-Net:     David Gurecki @ 1:2609/2
  348.                     Mirror Image @ 1:260/513
  349.  
  350.  
  351.  
  352. Special Thanks to:
  353. ==================
  354. Dan Peck, for his continuing assistance and sharing of his vast C programming
  355.   knowledge. Thanks!
  356. Eric Hayduk, for Betatesting, motivational support, and ideas about
  357.   registration code process. Thanks!
  358. Adam Hutchinson, for motivational support, continuing suggestions, and for
  359.   suggesting to release as Shareware. Thanks!
  360.  
  361. And, ESPECIALLY, to ALL those people who have written E-Mail and contributed
  362. suggestions to me about Memorize. You guys are the ones who made this possible.
  363.